// NClass - Free class diagram editor
// Copyright (C) 2006-2009 Balazs Tihanyi
// 
// This program is free software; you can redistribute it and/or modify it under 
// the terms of the GNU General Public License as published by the Free Software 
// Foundation; either version 3 of the License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful, but WITHOUT 
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with 
// this program; if not, write to the Free Software Foundation, Inc., 
// 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

using System;
using System.Windows.Forms;
using NClass.DiagramEditor;

namespace NClass.GUI
{
	public abstract class Plugin
	{
		NClassEnvironment environment;

		/// <exception cref="ArgumentNullException">
		/// <paramref name="environment"/> is null.
		/// </exception>
		protected Plugin(NClassEnvironment environment)
		{
			if (environment == null)
				throw new ArgumentNullException("environment");

			this.environment = environment;
		}

		protected NClassEnvironment NClassEnvironment
		{
			get { return environment; }
		}

		protected Workspace Workspace
		{
			get { return environment.Workspace; }
		}

		protected DocumentManager DocumentManager
		{
			get { return environment.DocumentManager; }
		}

		public abstract bool IsAvailable
		{
			get;
		}

		public abstract ToolStripItem MenuItem
		{
			get;
		}
	}
}